Skip to content

Add README usage guidance and examples links#27

Merged
Daniel15568 merged 1 commit into
data-centt:mainfrom
tusharrworkk-lab:readme-usage-clean
Jul 17, 2026
Merged

Add README usage guidance and examples links#27
Daniel15568 merged 1 commit into
data-centt:mainfrom
tusharrworkk-lab:readme-usage-clean

Conversation

@tusharrworkk-lab

Copy link
Copy Markdown
Contributor

Summary

  • add a short README section showing how to use percentify
  • add links to worked examples and the full documentation
  • address the good first issue about README usage guidance

Test plan

  • review README diff
  • confirm examples links point to the docs site
  • docs-only change

Clarify how to use percentify in practice and point readers to the full worked examples in the documentation.
Comment thread README.md

## Examples

- [Worked examples for every function](https://data-centt.github.io/percentify/documentation/)

@Daniel15568 Daniel15568 Jul 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would need extra use examples outside the docs. I'll merge this and rewrite issue.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright. I will put in more examples then

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. if you feel like anything more could be added. I will be happy to make one more pr for the same

@Daniel15568
Daniel15568 merged commit e65f926 into data-centt:main Jul 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants